/*
 *  Copyright 2013 National Institute of Advanced Industrial Science and Technology
 *  
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *  
 *      http://www.apache.org/licenses/LICENSE-2.0
 *  
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */

package org.sss.mapreduce;

import java.io.Serializable;

import org.sss.mapreduce.datatype.Packable;

/**
 * <code>Tuple</code> is a wrapper class to keep <code>Packable</code> key and value pair.
 */
@SuppressWarnings("serial")
public class Tuple<K extends Packable, V extends Packable> implements Serializable {
  private K key;
  private V value;

  /**
   * Allocate a <code>Tuple</code> object and initialize it so that
   * it holds the given <tt>key</tt> and <tt>value</tt> objects.
   */
  public Tuple(K key, V value) {
    this.key = key;
    this.value = value;
  }

  /**
   * Get key.
   */
  public K getKey() {
    return key;
  }

  /**
   * Get value.
   */
  public V getValue() {
    return value;
  }

  public long getRoughSize() {
    return key.getRoughSize() + value.getRoughSize();
  }

  @Override
  public String toString() {
    return "(" + key.toString() + ", " + value.toString() + ")";
  }
}
